dxp-ux
TMF-629 SecurityQuestion (Digital Website)
This API is used to update Security Questions for PIN reset towards Salesforce
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/customer/{id}url Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
| id | string | Identifier of the Customer. msisdn in this case | Y |
Header
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
cURL request
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/dev/dxp-ux/dxp-ux/v1/PR/customer/242566' \
--header 'client_id: abcde' \
--header 'client_secret: 12345' \
--header 'X-Correlation-ID: 5478-asdf5454-sad545-sear545dsf-54e5d4g' \
--header 'Content-Type: application/json' \
--data-raw '{
"status": "updateCustomerAccount",
"statusReason": "updateCustomerQuestionnaire",
"engagedParty": {
"id": "123456745",
"@referredType": "Individual",
"name": "msisdn"
},
"characteristic": [
{
"name": "Questionnaire",
"valueType": "array",
"value": [
{
"id": "1",
"value": "someone"
},
{
"id": "3",
"value": "hometown"
},
{
"id": "6",
"value": "good"
},
{
"id": "10",
"value": "Blue"
},
{
"id": "11",
"value": "Travel"
}
]
},
{
"name": "sourceSystem",
"value": "Digital"
}
]
}'Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| status | string | Used to track the lifecycle status of the customer. Ex : updateCustomerAccount | Y |
| statusReason | string | A string providing an explanation on the value of the status lifecycle. Ex: updateCustomerQuestionnaire | Y |
| engagedParty | object | Related Entity reference | Y |
| engagedParty.id | string | Unique identifier of a related entity. msisdn in this case | Y |
| engagedParty.@referredType | string | The actual type of the target instance when needed for disambiguation | Y |
| engagedParty.name | string | Name of the related entity | Y |
| characteristic | array | Describes the characteristic of a customer. | Y |
| characteristic.name | string | Name of the characteristic | Y |
| characteristic.valueType | string | Data type of the value of the characteristic | N |
| characteristic.value | any | Value of the characteristic | Y |
Note: For SYS layers it's necessary to define the elements present in characteristic[] resources
| characteristic name | type | description |
|---|---|---|
| Questionnaire | array | Holds information of questionnaire |
| sourceSystem | string | Identifier of the request source |
Response
{
"status": "Customer Questionnaire Update Success",
"engagedParty": {
"id": "123456745",
"@referredType": "Individual",
"name": "msisdn"
}
}Definitions
Each of the response parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| status | string | Status of the request | Y |
| engagedParty | array | Related Entity reference | Y |
| engagedParty.id | string | Unique identifier of a related entity. msisdn in this case | Y |
| engagedParty.@referredType | string | The actual type of the target instance when needed for disambiguation | Y |
| engagedParty.name | string | Name of the related entity | Y |